[Misc] Miscellaneous Settings

This section collects basic settings, including the name and location of your backup. The section also indicates whether you are keeping more than a single backup file, as specified by the restorePointLimit parameter.

Parameter Default Configuration Setting and Description
snapshotName
snapshotName

Specifies the name of the directory vbr creates for the full or object-level backup. This directory appears beneath a top-level directory named for the node being backed up.

Valid Values:

  • a–z
  • A – Z
  • 0 – 9
  • Hyphen (-)
  • Underscore (_)
tempDir
/tmp/vbr

Specifies an absolute path to a temporary storage area on the cluster nodes. The tmp path must be the same on all nodes in the cluster. The vbr utility uses this directory as a temporary location while it is copying files from the source cluster node to the destination backup location. Vertica also writes backup logs to this location. The vbr utility uses this directory as a temporary location for log files, lock files and other bookkeeping information during the execution of a task.

Do not specify the same location as your database's data or catalog directory. Any unexpected files or directories in your data or catalog location can cause errors during database start or restore.

The file system at this location must support fcntl lockf (POSIX) file locking.

restorePointLimit
1

Specifies the number of historical backups to retain in addition to the most recent backup. For example, if you set restorePointLimit=3, Vertica saves three historical backups, in addition to the most recent backup, for a total of four backups. By default, Vertica maintains a current backup and one historical backup. Saving multiple backups lets you back up incrementally. Enter a positive integer.

Saves multiple backups to the same location, which are shared through hard links. In such cases, listbackup displays the common backup prefix but indicates unique time and date suffixes:

my_archive20111111_205841
objects

None

Specifies whether vbr creates a full or object-level backup. If you do not specify any objects, vbr creates a full backup. Otherwise, specify the object names (schemas or tables) to include in a backup. To enter more than one object, enter multiple names in a comma-separated list.

Enter table names in the form schema.objectname. For example, to make backups of the table customers from the schema finance, enter finance.customers. If a public table and a schema have the same name, vbr backs up only the schema. Use the schema.objectname convention to avoid confusion.

Object names can include UTF-8 alphanumeric characters. Object names cannot include escape characters, single quote (') or double quote (") characters.

To use non-alphanumeric characters, use a backslash (\) followed by a hex value. For instance, if the table name is a my table (my followed by a space character, then table), enter the object name as follows:

objects=my\20table

This parameter also identifies objects that you want to replicate to an alternate cluster.

objectRestoreMode
createOrReplace

Specifies how Vertica handles objects of the same name when restoring schema or table backups.

Valid Values:

  • createOrReplace
  • create
  • coexist

For descriptions of these settings, refer to Creating vbr Configuration Files.

retryCount
2

Specifies the number of backup attempts to complete execution after an error occurs. If the backup fails after exceeding the number of retry attempts, the utility reports an error and stops processing.

retryDelay
1

Specifies the number of seconds to wait between backup retry attempts, if a failure occurs.

passwordFile
None
Specifies the file name of the password configuration file.
enableFreeSpaceCheck
True
When enabled, Vertica confirms that the specified backup locations contain sufficient free space and inodes to allow a successful backup. If a backup location has insufficient resources, Vertica displays an error message and cancels the backup. If Vertica cannot determine the amount of available space or number of inodes in the backupDir, it displays a warning and continues with the backup.
If you do not include this setting in your configuration file, Vertica performs the space check by default.
SnapshotEpochLagFailureThreshold
3600
When performing a backup, replication, or copycluster, specifies the maximum acceptable difference, in seconds, between the current epoch and the backup epoch. If the time between the current epoch and the backup epoch exceeds the value specified in this parameter, Vertica displays an error message. A value of 0 disables this check. If you do not include this setting in your configuration file, Vertica performs this check using the default value. Backups do not contain information committed after the backup epoch.